Add missing Since: gtk-doc markup for newly added GSEAL API. Change all
authorJohan Dahlin <jdahlin@async.com.br>
Fri, 20 Jun 2008 13:54:31 +0000 (13:54 +0000)
committerJohan Dahlin <johan@src.gnome.org>
Fri, 20 Jun 2008 13:54:31 +0000 (13:54 +0000)
2008-06-20  Johan Dahlin  <jdahlin@async.com.br>

    * gtk/gtkaccelgroup.c:
    * gtk/gtkcolorseldialog.c:
    * gtk/gtkcontainer.c:
    * gtk/gtkdialog.c:
    * gtk/gtkentry.c (gtk_entry_class_init):
    * gtk/gtkfontsel.c:
    * gtk/gtkhandlebox.c:
    * gtk/gtklayout.c:
    * gtk/gtkmenu.c (gtk_menu_class_init):
    * gtk/gtkmenuitem.c (gtk_menu_item_class_init):
    * gtk/gtkplug.c (gtk_plug_class_init):
    * gtk/gtkselection.c:
    * gtk/gtksocket.c:
    * gtk/gtktreeselection.c:
    * gtk/gtkwidget.c (gtk_widget_class_init):
    * gtk/gtkwindow.c:
    Add missing Since: gtk-doc markup for newly added GSEAL API.
    Change all Since: GSEAL-branch to Since: 2.14.

svn path=/trunk/; revision=20639

17 files changed:
ChangeLog
gtk/gtkaccelgroup.c
gtk/gtkcolorseldialog.c
gtk/gtkcontainer.c
gtk/gtkdialog.c
gtk/gtkentry.c
gtk/gtkfontsel.c
gtk/gtkhandlebox.c
gtk/gtklayout.c
gtk/gtkmenu.c
gtk/gtkmenuitem.c
gtk/gtkplug.c
gtk/gtkselection.c
gtk/gtksocket.c
gtk/gtktreeselection.c
gtk/gtkwidget.c
gtk/gtkwindow.c

index 2faee051f845328158ab8dcfc052c2911f6cfd8b..d0307c8607099609109f12c8bcba647dd891a183 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,24 @@
+2008-06-20  Johan Dahlin  <jdahlin@async.com.br>
+
+       * gtk/gtkaccelgroup.c:
+       * gtk/gtkcolorseldialog.c:
+       * gtk/gtkcontainer.c:
+       * gtk/gtkdialog.c:
+       * gtk/gtkentry.c (gtk_entry_class_init):
+       * gtk/gtkfontsel.c:
+       * gtk/gtkhandlebox.c:
+       * gtk/gtklayout.c:
+       * gtk/gtkmenu.c (gtk_menu_class_init):
+       * gtk/gtkmenuitem.c (gtk_menu_item_class_init):
+       * gtk/gtkplug.c (gtk_plug_class_init):
+       * gtk/gtkselection.c:
+       * gtk/gtksocket.c:
+       * gtk/gtktreeselection.c:
+       * gtk/gtkwidget.c (gtk_widget_class_init):
+       * gtk/gtkwindow.c:
+       Add missing Since: gtk-doc markup for newly added GSEAL API.
+       Change all Since: GSEAL-branch to Since: 2.14.
+
 2008-06-20  Michael Natterer  <mitch@imendio.com>
 
        * gtk/gtkaccelgroup.[ch]: fix some formatting and whitespace in
index 9c30d611e20c511022b3ffbe85b37849568da5ad..b41002b5f3ef34c68fdfb9cf80b2347999e6510f 100644 (file)
@@ -225,6 +225,8 @@ gtk_accel_group_new (void)
  *
  * Locks are added and removed using gtk_accel_group_lock() and
  * gtk_accel_group_unlock().
+ *
+ * Since: 2.14
  */
 gboolean
 gtk_accel_group_get_is_locked (GtkAccelGroup *accel_group)
@@ -240,6 +242,8 @@ gtk_accel_group_get_is_locked (GtkAccelGroup *accel_group)
  *
  * @returns: #GdkModifierType representing the mask for this
  * @accel_group. For example, #GDK_CONTROL_MASK, #GDK_SHIFT_MASK, etc.
+ *
+ * Since: 2.14
  */
 GdkModifierType
 gtk_accel_group_get_modifier_mask (GtkAccelGroup *accel_group)
index 92ac87d9bb9f97d867ccfc674b1e62a17e7e432d..1345a0cdef58d39c68719ae12f729e959bc2d716 100644 (file)
@@ -193,7 +193,7 @@ gtk_color_selection_dialog_new (const gchar *title)
  *
  * Retrieves the #GtkColorSelection widget embedded in the dialog.
  *
- * Since:  GSEAL-branch
+ * Since: 2.14
  **/
 GtkWidget*
 gtk_color_selection_dialog_get_color_selection (GtkColorSelectionDialog *colorsel)
index b24dde9aa6dda81ed909dbf309dd752ed10771ab..2f6b0be91fcb28694f31aae116ffbcc77ea17fab 100644 (file)
@@ -1568,7 +1568,7 @@ gtk_container_set_focus_child (GtkContainer *container,
  * Returns: The child widget which has the focus
  *          inside @container, or %NULL if none is set.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 GtkWidget *
 gtk_container_get_focus_child (GtkContainer *container)
index 99bd11cd2fe67c5bff07ae6aac7ce123c45ac709..3ee464d13d2effd33ebb19892c629f84188b679c 100644 (file)
@@ -1487,7 +1487,7 @@ gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
  *
  * Returns: the action area.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 GtkWidget *
 gtk_dialog_get_action_area (GtkDialog *dialog)
@@ -1508,7 +1508,7 @@ gtk_dialog_get_action_area (GtkDialog *dialog)
  * This function similar to gtk_box_pack_start() packs @widget
  * with reference to the start of @dialog.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 void
 gtk_dialog_pack_start (GtkDialog *dialog,
@@ -1535,7 +1535,7 @@ gtk_dialog_pack_start (GtkDialog *dialog,
  * This function similar to gtk_box_pack_end() packs @widget
  * with reference to the end of @dialog.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 void
 gtk_dialog_pack_end (GtkDialog *dialog,
index 073472b2b87313b798448c3f78f26bb906095e64..8fe531618dbe42962838694ee650a2cc82f00d6d 100644 (file)
@@ -639,7 +639,7 @@ gtk_entry_class_init (GtkEntryClass *class)
    *
    * If text is overwritten when typing in the #GtkEntry.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    */
   g_object_class_install_property (gobject_class,
                                    PROP_OVERWRITE_MODE,
@@ -653,7 +653,7 @@ gtk_entry_class_init (GtkEntryClass *class)
    *
    * The length of the text in the #GtkEntry.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    */
   g_object_class_install_property (gobject_class,
                                    PROP_TEXT_LENGTH,
@@ -4679,7 +4679,7 @@ gtk_entry_set_editable (GtkEntry *entry,
  * 
  * Sets whether the text is overwritten when typing in the #GtkEntry.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 void
 gtk_entry_set_overwrite_mode (GtkEntry *entry,
@@ -4703,7 +4703,7 @@ gtk_entry_set_overwrite_mode (GtkEntry *entry,
  * 
  * Return value: whether the text is overwritten when typing.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 gboolean
 gtk_entry_get_overwrite_mode (GtkEntry *entry)
@@ -4809,7 +4809,7 @@ gtk_entry_get_max_length (GtkEntry *entry)
  * Return value: the current number of characters
  *               in #GtkEntry, or 0 if there are none.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 guint16
 gtk_entry_get_text_length (GtkEntry *entry)
index d0a78a74b6b6ba3f8e8e231236776b9d6e9dae39..5a0ef873e2a951548bb18676a59cd09da4421a89 100644 (file)
@@ -1129,7 +1129,9 @@ gtk_font_selection_get_font_internal (GtkFontSelection *fontsel)
  * This returns the #GtkEntry that allows the user to manually enter
  * the font family they want to use.
  * 
- * Return value: A #GtkWidget. 
+ * Return value: A #GtkWidget.
+ *
+ * Since: 2.14
  **/
 GtkWidget *
 gtk_font_selection_get_family_entry (GtkFontSelection *fontsel)
@@ -1147,6 +1149,8 @@ gtk_font_selection_get_family_entry (GtkFontSelection *fontsel)
  * example, 'Sans', 'Serif', etc.
  * 
  * Return value: A #GtkWidget. 
+ *
+ * Since: 2.14
  **/
 GtkWidget *
 gtk_font_selection_get_family_list (GtkFontSelection *fontsel)
@@ -1164,6 +1168,8 @@ gtk_font_selection_get_family_list (GtkFontSelection *fontsel)
  * configuration of the font style.
  * 
  * Return value: A #GtkWidget. 
+ *
+ * Since: 2.14
  **/
 GtkWidget *
 gtk_font_selection_get_face_entry (GtkFontSelection *fontsel)
@@ -1181,6 +1187,8 @@ gtk_font_selection_get_face_entry (GtkFontSelection *fontsel)
  * the selected font. For example, 'Regular', 'Bold', etc.
  * 
  * Return value: A #GtkWidget. 
+ *
+ * Since: 2.14
  **/
 GtkWidget *
 gtk_font_selection_get_face_list (GtkFontSelection *fontsel)
@@ -1198,6 +1206,8 @@ gtk_font_selection_get_face_list (GtkFontSelection *fontsel)
  * number manually instead of selecting it from the list of font sizes. 
  * 
  * Return value: A #GtkWidget. 
+ *
+ * Since: 2.14
  **/
 GtkWidget *
 gtk_font_selection_get_size_entry (GtkFontSelection *fontsel)
@@ -1214,6 +1224,8 @@ gtk_font_selection_get_size_entry (GtkFontSelection *fontsel)
  * This returns the #GtkTreeeView used to list font sizes. 
  * 
  * Return value: A #GtkWidget. 
+ *
+ * Since: 2.14
  **/
 GtkWidget *
 gtk_font_selection_get_size_list (GtkFontSelection *fontsel)
@@ -1230,6 +1242,8 @@ gtk_font_selection_get_size_list (GtkFontSelection *fontsel)
  * This returns the #GtkEntry used to display the font as a preview.
  *
  * Return value: A #GtkWidget. 
+ *
+ * Since: 2.14
  **/
 GtkWidget *
 gtk_font_selection_get_preview_entry (GtkFontSelection *fontsel)
@@ -1245,6 +1259,8 @@ gtk_font_selection_get_preview_entry (GtkFontSelection *fontsel)
  * 
  * Return value: A #PangoFontFamily representing the selected font
  * family. Font families are a collection of font faces.
+ *
+ * Since: 2.14
  **/
 PangoFontFamily *
 gtk_font_selection_get_family (GtkFontSelection *fontsel)
@@ -1260,6 +1276,8 @@ gtk_font_selection_get_family (GtkFontSelection *fontsel)
  * 
  * Return value: A #PangoFontFace representing the selected font group
  * details (i.e. family, slant, weight, width, etc).   
+ *
+ * Since: 2.14
  **/
 PangoFontFace *
 gtk_font_selection_get_face (GtkFontSelection *fontsel)
@@ -1275,6 +1293,8 @@ gtk_font_selection_get_face (GtkFontSelection *fontsel)
  * 
  * Return value: A #gint representing the font size selected, or -1
  * if not.
+ *
+ * Since: 2.14
  **/
 gint
 gtk_font_selection_get_size (GtkFontSelection *fontsel)
@@ -1583,6 +1603,8 @@ gtk_font_selection_dialog_new (const gchar *title)
  * @fsd: a #GtkFontSelectionDialog
  *
  * Return value: the #GtkWidget used in the dialog for the 'OK' button.
+ *
+ * Since: 2.14
  */
 GtkWidget *
 gtk_font_selection_dialog_get_ok_button (GtkFontSelectionDialog *fsd)
@@ -1597,6 +1619,8 @@ gtk_font_selection_dialog_get_ok_button (GtkFontSelectionDialog *fsd)
  * @fsd: a #GtkFontSelectionDialog
  *
  * Return value: the #GtkWidget used in the dialog for the 'Apply' button.
+ *
+ * Since: 2.14
  */
 GtkWidget *
 gtk_font_selection_dialog_get_apply_button (GtkFontSelectionDialog *fsd)
index d6435f4b02b8b823b1d8ca07fc37fed0be32c8fc..2897ccc82c7935d8298a305a93f377b030e5a9b4 100644 (file)
@@ -870,7 +870,7 @@ gtk_handle_box_get_snap_edge (GtkHandleBox *handle_box)
  *
  * Return value: %TRUE if the child is currently detached, otherwise %FALSE
  *
- * Since:  GSEAL-branch
+ * Since: 2.14
  **/
 gboolean
 gtk_handle_box_get_child_detached (GtkHandleBox *handle_box)
index 82cf4c61057b55557140aac3775258edd22a97ce..87ddaeb0240c0246eff7fcc2f3d9efbbe025dc79 100644 (file)
@@ -150,9 +150,11 @@ gtk_layout_new (GtkAdjustment *hadjustment,
  * Retrieve the bin window of the layout used for drawing operations.
  * 
  * Return value: a #GdkWindow
+ *
+ * Since: 2.14
  **/
 GdkWindow*
-gtk_layout_get_bin_window (GtkLayout     *layout)
+gtk_layout_get_bin_window (GtkLayout *layout)
 {
   g_return_val_if_fail (GTK_IS_LAYOUT (layout), NULL);
 
index 03d2c16ada50a6195ab62740b42bdb3818c3e394..63bc5e3563abd8f46864f538ad685085168f99c4 100644 (file)
@@ -493,7 +493,7 @@ gtk_menu_class_init (GtkMenuClass *class)
    *
    * The currently selected menu item.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    **/
   g_object_class_install_property (gobject_class,
                                    PROP_ACTIVE,
@@ -508,7 +508,7 @@ gtk_menu_class_init (GtkMenuClass *class)
    *
    * The accel group holding accelerators for the menu.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    **/
   g_object_class_install_property (gobject_class,
                                    PROP_ACCEL_GROUP,
@@ -523,7 +523,7 @@ gtk_menu_class_init (GtkMenuClass *class)
    *
    * An accel path used to conveniently construct accel paths of child items.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    **/
   g_object_class_install_property (gobject_class,
                                    PROP_ACCEL_PATH,
@@ -538,7 +538,7 @@ gtk_menu_class_init (GtkMenuClass *class)
    *
    * The widget the menu is attached to.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    **/
   g_object_class_install_property (gobject_class,
                                    PROP_ACCEL_PATH,
@@ -576,7 +576,7 @@ gtk_menu_class_init (GtkMenuClass *class)
    *
    * The monitor the menu will be popped up on.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    **/
   g_object_class_install_property (gobject_class,
                                    PROP_MONITOR,
@@ -1767,11 +1767,11 @@ gtk_menu_set_accel_path (GtkMenu     *menu,
 
 /**
  * gtk_menu_get_accel_path
- * @menu:       a valid #GtkMenu
+ * @menu: a valid #GtkMenu
  *
  * Retrieves the accelerator path set on the menu.
  *
- * Since:  GSEAL-branch
+ * Since: 2.14
  */
 const gchar*
 gtk_menu_get_accel_path (GtkMenu     *menu)
@@ -5051,10 +5051,10 @@ gtk_menu_set_monitor (GtkMenu *menu,
  *
  * Retrieves the number of the monitor on which to show the menu.
  *
- * Since: GSEAL-branch
- *
  * Returns: the number of the monitor on which the menu should
  *    be popped up or -1
+ *
+ * Since: 2.14
  **/
 gint
 gtk_menu_get_monitor (GtkMenu *menu)
index 593c931dbc7c46e72ab6203cd1de5950e2bae3f9..0696d2131714926cf4f8ed49dc9e9b883ff92ae8 100644 (file)
@@ -196,7 +196,7 @@ gtk_menu_item_class_init (GtkMenuItemClass *klass)
    *
    * Sets whether the menu item appears justified at the right side of a menu bar.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    **/
   g_object_class_install_property (gobject_class,
                                    PROP_RIGHT_JUSTIFIED,
@@ -228,7 +228,7 @@ gtk_menu_item_class_init (GtkMenuItemClass *klass)
    * changes of the menu item's accelerator caused by the user can be
    * identified and saved to persistant storage.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    **/
   g_object_class_install_property (gobject_class,
                                    PROP_ACCEL_PATH,
@@ -1688,6 +1688,8 @@ gtk_menu_item_set_accel_path (GtkMenuItem *menu_item,
  *
  * Returns: the accelerator path corresponding to this menu item's
  *              functionality, or %NULL if not set
+ *
+ * Since: 2.14
  */
 G_CONST_RETURN gchar *
 gtk_menu_item_get_accel_path (GtkMenuItem *menu_item)
index ff3f9131e1df74e58e909e2f5bc9d575a582a8ce..15238218fdf223a5b3abdc822679cebd7989afd0 100644 (file)
@@ -157,7 +157,7 @@ gtk_plug_class_init (GtkPlugClass *class)
    *
    * The window of the socket the plug is embedded in.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    */
   g_object_class_install_property (gobject_class,
                                   PROP_SOCKET_WINDOW,
@@ -270,6 +270,8 @@ gtk_plug_get_id (GtkPlug *plug)
  * Determines whether the plug is embedded in a socket.
  *
  * Return value: %TRUE if the plug is embedded in a socket
+ *
+ * Since: 2.14
  **/
 gboolean
 gtk_plug_get_embedded (GtkPlug *plug)
@@ -286,6 +288,8 @@ gtk_plug_get_embedded (GtkPlug *plug)
  * Retrieves the socket the plug is embedded in.
  *
  * Return value: the window of the socket, or %NULL
+ *
+ * Since: 2.14
  **/
 GdkWindow *
 gtk_plug_get_socket_window (GtkPlug *plug)
index 8c0398e7c242a12c5455bf2170cf96ebb0dbe444..d0a49da1fdc9120b0aa0fcb43300b4caf5b0ec24 100644 (file)
@@ -1115,7 +1115,7 @@ gtk_selection_convert (GtkWidget *widget,
  *
  * Retrieves the target of the selection.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 GdkAtom
 gtk_selection_data_get_target (GtkSelectionData *selection_data)
@@ -1131,7 +1131,7 @@ gtk_selection_data_get_target (GtkSelectionData *selection_data)
  *
  * Retrieves the data type of the selection.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 GdkAtom
 gtk_selection_data_get_data_type (GtkSelectionData *selection_data)
@@ -1147,7 +1147,7 @@ gtk_selection_data_get_data_type (GtkSelectionData *selection_data)
  *
  * Retrieves the format of the selection.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 gint
 gtk_selection_data_get_format (GtkSelectionData *selection_data)
@@ -1166,7 +1166,7 @@ gtk_selection_data_get_format (GtkSelectionData *selection_data)
  *
  * If @length is not %NULL it is filled with the length of data.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 const guchar*
 gtk_selection_data_get_data (GtkSelectionData *selection_data,
@@ -1186,7 +1186,7 @@ gtk_selection_data_get_data (GtkSelectionData *selection_data,
  *
  * Retrieves the display of the selection.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 GdkDisplay *
 gtk_selection_data_get_display (GtkSelectionData *selection_data)
index ab0f620d071931a9b5af24f4fbeb4bfd65636f30..eaef2f119acc6bebf83b0902a50cc1637b3956a2 100644 (file)
@@ -309,7 +309,7 @@ gtk_socket_get_id (GtkSocket *socket)
  *
  * Return value: the window of the plug if available, or %NULL
  *
- * Since:  GSEAL-branch
+ * Since:  2.14
  **/
 GdkWindow*
 gtk_socket_get_plug_window (GtkSocket *socket)
index e52ef90959f31453dca97ff79e09f88387064179..092e1d30b4192fbe1cf9fc5924b19bdcfcd7505d 100644 (file)
@@ -282,7 +282,7 @@ gtk_tree_selection_set_select_function (GtkTreeSelection     *selection,
  *
  * Return value: The function.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 GtkTreeSelectionFunc
 gtk_tree_selection_get_select_function (GtkTreeSelection *selection)
index 6b5c49fcf3dcf9ba5e167d16acaccc9f0491617d..16a3aec5098d846fe1f36e4652294f8aab7e919c 100644 (file)
@@ -679,7 +679,7 @@ gtk_widget_class_init (GtkWidgetClass *klass)
    *
    * The widget's window if it is realized, %NULL otherwise.
    *
-   * Since: GSEAL-branch
+   * Since: 2.14
    */
   g_object_class_install_property (gobject_class,
                                   PROP_WINDOW,
@@ -9894,7 +9894,7 @@ gtk_widget_get_has_tooltip (GtkWidget *widget)
  *
  * Return value: widget's allocation
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  */
 GtkAllocation
 gtk_widget_get_allocation (GtkWidget *widget)
@@ -9913,7 +9913,7 @@ gtk_widget_get_allocation (GtkWidget *widget)
  *
  * Return value: @widget's window.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  */
 GdkWindow*
 gtk_widget_get_window (GtkWidget *widget)
index ff64adc5e6ba9bf8e5cbe7d33221c5c8d5cb2acf..1e9f7e2e0ab2d79984f79a4651cc8e4ddcbc263b 100644 (file)
@@ -1522,7 +1522,7 @@ gtk_window_set_default (GtkWindow *window,
  *
  * Returns: the default widget, or %NULL if there is none.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 GtkWidget *
 gtk_window_get_default (GtkWindow *window)
@@ -7464,7 +7464,7 @@ gtk_window_group_remove_window (GtkWindowGroup *window_group,
  *
  * Returns: A newly-allocated list of windows inside the group.
  *
- * Since: GSEAL-branch
+ * Since: 2.14
  **/
 GList *
 gtk_window_group_list_windows (GtkWindowGroup *window_group)